リンクタイプ Plusインタフェース仕様（決済共通）

決済共通インタフェース

概要

本章では、パラメータ型、キー型共通のURL作成に必要な実行パラメータセット、および、画面遷移、結果パラメータセットを解説します。

パラメータ型決済URLの構成

パラメータ型のリンクタイプ Plus決済URLを以下に示します。

①	プロトコル	https（httpは利用不可)
②	ドメイン	環境によって異なります。本番環境：link.mul-pay.jp テスト環境： stg.link.mul-pay.jp
③	バージョン	"v1"固定です。
④	機能名	"plus"固定です。
⑤	ショップID	加盟店様のショップIDです。
⑥	機能種別	決済機能を示す"checkout"を指定します。
⑦	ハッシュ付き実行パラメータセット	取引を定義するためのパラメータのbase64（※）文字列です。詳細については後述します。（※ URLSafe／文字コード：UTF-8）

ハッシュ付き実行パラメータセットの生成方法

リンクタイプ Plusの決済画面を呼び出すためには、取引の内容を示す各種パラメータ(決済金額や取引を特定するオーダーID等)一式が必要です。これらパラメータ一式を「実行パラメータセット」と呼びます。実行パラメータセットはjson形式で表現しますが、リンクタイプ Plus決済URLに付与する際は、base64エンコード（URLSafe）を行い、パラメータ改ざんチェック用にハッシュを付与したハッシュ付き実行パラメータセット文字列にします。

ハッシュ付き実行パラメータセットの導出方法を以下に示します。

パラメータ型決済URL生成コードサンプル

パラメータ型決済URL生成時のコードサンプルは管理画面より確認できます。

ご利用には管理画面にログインする必要があります。

1.　トップメニューの"コードサンプル"をクリック

2.　決済プルダウンより"リンクタイプ PLUS"を選択し、言語を選択

3.　"表示"をクリック

4.　"決済URL生成(V1)"をクリック

ハッシュについて

お客様がリンクタイプ Plus決済URLにアクセスすると、弊社システムではURLからハッシュ付き実行パラメータを取得しハッシュ値の検証を行います。
ハッシュ値が正しい場合は決済画面を表示しますが、ハッシュ値が異なる場合は不正なアクセスと扱い、エラー画面を表示します。

本チェック処理により、悪意を持った実行パラメータセットの改ざんを検知/ブロックします。

注意

・生成したURLはお客様が画面表示するまでエラーが発生するかの確認ができません。パラメータに不正な値が設定されている場合は画面表示時にエラーとなり、お客様が決済を行えないため設定漏れやミスがないようにご注意ください。
・実行パラメータのjson keyは大文字小文字を判別しております。大文字小文字の設定を誤らないようご注意ください。
・URLSafeなbase64エンコードを行ってください。URLSafeではない場合、URLに「+」「/」「=」の文字列が含まれる可能性があり、アクセス時にエラーとなります（末尾の「=（パディング）」は許可）。
・文字コード：UTF-8

キー型決済URLの構成

キー型のリンクタイプ Plus決済URLを以下に示します。

①	プロトコル	https（httpは利用不可)
②	ドメイン	環境によって異なります。本番環境：link.mul-pay.jp テスト環境： stg.link.mul-pay.jp
③	バージョン	"v2"固定です。
④	機能名	"plus"固定です。
⑤	ショップID	加盟店様のショップIDです。
⑥	機能種別	決済機能を示す"checkout"を指定します。
⑦	キー	取引を特定するためのキーです。

実行パラメータセットのデフォルト値について

実行パラメータセットの各パラメータ値は、加盟店様が管理画面上でデフォルト値を設定することが可能です。
リンクタイプ Plus決済URLで省略した実行パラメータに対しては加盟店様が設定したデフォルト値が使用されます（リンクタイプ Plus決済URLとデフォルト値の両方が指定されていた場合はリンクタイプ Plus決済URLで指定した値が使用されます）。

また、実行パラメータのデフォルト値は、管理画面上で複数登録できます。デフォルト値を登録する際は「設定ID」を指定し、その「設定ID」に対して実行パラメータのデフォルト値を登録します（デフォルト値の登録方法については、管理画面マニュアルをご覧ください）。
リンクタイプ Plus決済URLにおいて、「設定ID」を指定することにより、複数登録されているデフォルト実行パラメータセットの中から使用するパラメータ値を特定します。

遷移先URL/リトライ回数/画面デザイン等の取引毎に共通(不変)な実行パラメータは管理画面でデフォルト値を設定し、リンクタイプ Plus決済URLでは決済金額/オーダーID等の取引毎に異なる実行パラメータのみを指定してください。

ワンポイント：パラメータ型決済URLについて

リンクタイプ Plus決済URLに付与したパラメータはお客様の目に触れますので、リンクタイプ Plus決済URLで指定する実行パラメータは必要最低限な項目にし、極力デフォルト値を使用することをお勧めします。
また、ブラウザによってはURL長制限がございますので、最大2,000バイトを目安に実行パラメータを設定してください。

実行パラメータセット項目説明

実行パラメータは、加盟店様が指定する入力パラメータ群であり、リンクタイプ Plus決済画面表示および決済実行に必要な項目です。これらの項目はリンクタイプ Plus決済URLの一部として指定するか、管理画面のリンクタイプ Plus設定画面で指定します。

実行パラメータは、共通部と決済固有部に大別されます。
本章では共通部について説明します（決済固有部については各決済手段の章をご覧ください）。

ワンポイント

決済固有部の必須項目が未設定、または形式エラーが発生している場合、決済選択/入力画面に該当の決済手段は表示されません。

実行パラメータ項目(決済共通部)

json key

詳細

指定可能箇所

システムデフォルト設定

リンクタイプPlus決済URL

加盟店デフォルト設定

configid

必須半角英数字16桁

設定ID

管理画面で登録したデフォルト実行パラメータセットの設定IDを指定します。

〇

(null)

transaction

必須

取引共通項目

取引で必要なパラメータセットです。

〇

OrderID

必須半角英数字記号27桁

オーダーID

〇

(null)

Amount

必須半角数字10桁

利用金額

決済で使用する金額です。AmountとTaxの合計値が0よりも大きい値を指定してください。

※決済手段によって決済可能な金額の上限/下限が異なります。
本項目で指定した金額が決済手段の決済可能な金額の条件を満たさない場合、その決済手段は決済画面に表示されません。

〇

(null)

Tax

半角数字10桁

税送料

決済で使用する金額です。AmountとTaxの合計値が0よりも大きい値を指定してください。

〇

(null)

ClientField1

全半角数字記号100バイト

加盟店自由項目1

〇

(null)

ClientField2

全半角数字記号100バイト

加盟店自由項目2

〇

(null)

ClientField3

全半角数字記号100バイト

加盟店自由項目3

〇

(null)

Overview

全半角数字記号64バイト

取引概要

決済画面の取引詳細欄に表示される取引概要です。
省略時は取引概要欄は表示されません。
半角英数字、半角記号(除く ^ ` { | } ~ & <> " ' )、全角文字が使用可能です。

〇

(null)

Detail

全半角数字記号256バイト

取引説明

決済画面の取引詳細欄に表示される取引説明です。
省略時は取引説明欄は表示されません。
半角英数字、半角記号(除く ^ ` { | } ~ & <> " ' )、全角文字が使用可能です。

〇

(null)

PayMethods

利用可能決済手段

決済画面に表示する決済手段の識別子を配列で指定します。

決済識別子	決済手段
credit	クレジットカード
cvs	コンビニ
payeasy	Pay-easy（ペイジー）
docomo	d払い
au	auかんたん決済
sb	ソフトバンクまとめて支払い
epospay	エポスかんたん決済
dcc	多通貨クレジットカード決済（DCC）
linepay	LINE Pay決済
famipay	FamiPay決済
merpay	メルペイ決済
rakutenid	楽天ペイ
rakutenpayv2	楽天ペイV2
paypay	PayPay
virtualaccount	銀行振込（バーチャル口座）
aupay	au PAY（ネット支払い）
ganb	銀行振込（バーチャル口座あおぞら）
unionpay	ネット銀聯

省略時は、契約済みかつ利用可能状態の決済手段が指定されたものとして動作します。
なお、決済手段の決済条件(決済金額の上限/下限)を満たしていない場合は、本項目で決済手段を指定しても決済画面に表示されません。

注意

単数の決済識別子を設定する場合も配列形式での指定が必要です。
例：["credit"]
複数の決済識別子を設定する場合例は以下の通りです。
例：["credit","cvs"]

〇

(null)

RetUrl

半角英数字記号256桁

戻り先URL

リンクタイプ Plus決済画面上に表示される「サイトに戻る」ボタン押下時の遷移先URLです。
「サイトに戻る」ボタンの遷移先を完了時とキャンセル時で個別に設定する場合は、
「完了時戻り先URL」と「キャンセル時戻り先URL」を設定してください。

「サイトに戻る」ボタンの動作パターンについては「決済画面からの加盟店様サイトへの遷移」をご覧ください。

〇

(null)

CompleteUrl

半角英数字記号256桁

完了時戻り先URL

リンクタイプ Plusレシート画面上に表示される「サイトに戻る」ボタン押下時の遷移先URLです。
本項目を設定した場合、「戻り先URL」の設定は無効になります。

「サイトに戻る」ボタンの動作パターンについては「決済画面からの加盟店様サイトへの遷移」をご覧ください。

〇

(null)

CancelUrl

半角英数字記号256桁

キャンセル時戻り先URL

リンクタイプ Plusレシート画面以外に表示される「サイトに戻る」ボタン押下時の遷移先URLです。
本項目を設定した場合、「戻り先URL」の設定は無効になります。

「サイトに戻る」ボタンの動作パターンについては「決済画面からの加盟店様サイトへの遷移」をご覧ください。

〇

(null)

NotifyMailaddress

半角英数字記号256桁

決済完了通知先メールアドレス

決済完了時に加盟店様に送付する決済完了通知メールの送付先メールアドレスです。
省略時は、決済完了通知メールが送信されません。

〇

(null)

RetryMax

半角数字2桁

リトライ最大回数

決済失敗時に再入力可能な回数です。
0～99を指定可能です。
管理画面で設定した値を使用します。

〇

ExpireDays

半角数字2桁

取引有効日数

リンクタイプ Plus取引の有効な日数です。

指定した日数を経過した時点で、リンクタイプ Plus取引は有効期限切れ状態になります。
※ステータスによっては、有効期限切れとならない場合もあります。詳細はステータス遷移図をご覧ください。

0を指定した場合は当日中、１を指定した場合は翌日中、省略時は無期限と扱われます。

決済可能期限も設定した場合、先に期限が到来する設定が有効になります。
詳細は注意事項をご覧ください。

〇

(null)

PaymentExpireDate

半角数字12桁

決済可能期限

決済画面を表示可能な期限を設定できます。
（yyyymmddhhMM形式）

例：「202006162359」を設定した場合、2020年6月17日0時以降は決済画面表示時にエラー

取引有効日数も設定した場合、先に期限が到来する設定が有効になります。
詳細は注意事項をご覧ください。

〇

(null)

ResultSkipFlag

半角数字1桁

結果画面スキップフラグ

ONにすると、結果画面をスキップし、完了時の戻り先に遷移します。
完了時の戻り先が設定されていない場合、結果画面はスキップされません。
完了時の戻り先はレシート画面の「サイトに戻るボタン」と同じ遷移先となります。
詳細は「決済画面からの加盟店様サイトへの遷移」をご覧ください。
0:OFF（スキップしない）
1:ON（スキップする）

以下の決済手段で結果画面をスキップする場合、支払いに必要な情報は加盟店様からお客様にご通知ください。
・コンビニ
・Pay-easy（ペイジー）
・銀行振込（バーチャル口座）

〇

ConfirmSkipFlag

半角数字1桁

確認画面スキップフラグ

ONにすると、確認画面をスキップし、次画面へ遷移します。
0:OFF（スキップしない）
1:ON（スキップする）

〇

TranDetailShowFlag

半角数字1桁

取引詳細初期表示フラグ

ONにすると決済画面で取引詳細を展開した状態が初期表示となります。
0:OFF（取引詳細を展開しない状態が初期表示）
1:ON（取引詳細を展開した状態が初期表示）

〇

customer

お客様情報

お客様に関するパラメータセットです。

MailAddress

半角英数字記号256桁

メールアドレス

お客様のメールアドレスです。

各決済手段の入力画面のメールアドレス欄のデフォルト値として使用されます。対象の決済手段は、customer情報が使用される決済手段一覧表をご確認ください。
各決済手段毎のパラメータでメールアドレスが指定されている場合、そちらの値が優先されます。

〇

(null)

CustomerName

全半角英数字記号40バイト

氏名

お客様の氏名です。

各決済手段の入力画面の氏名項目のデフォルト値として使用されます。対象の決済手段は、customer情報が使用される決済手段一覧表をご確認ください。
各決済手段毎のパラメータで氏名が指定されている場合、そちらの値が優先されます。

〇

(null)

CustomerKana

全半角英数字記号40バイト

氏名(カナ)

お客様の氏名のカナです。

各決済手段の入力画面の氏名(カナ)項目のデフォルト値として使用されます。対象の決済手段は、customer情報が使用される決済手段一覧表をご確認ください。
各決済手段毎のパラメータで氏名(カナ)が指定されている場合、そちらの値が優先されます。

〇

(null)

TelNo

半角数字13桁

電話番号

お客様の電話番号です。

各決済手段の入力画面の電話番号項目のデフォルト値として使用されます。対象の決済手段は、customer情報が使用される決済手段一覧表をご確認ください。
各決済手段毎のパラメータで電話番号が指定されている場合、そちらの値が優先されます。

〇

(null)

displaysetting

画面表示設定

画面表示に関するパラメータセットです。

TemplateID

テンプレートID

画面レイアウトを以下から選択可能です。

テンプレート識別子	特徴
designA	コンボボックスを使用して、決済手段を選択します。
designB	画像を使用して、決済手段を選択します。スマートフォンに適したテンプレートです。
designC	ボタンを使用して、決済手段を選択します。一目で選択可能な決済手段を確認できます。
designD	コンボボックスを使用して、決済手段を選択します。決済金額が分かりやすいデザインです。
1~5	オリジナルデザインの公開データが作成されている場合、1~5を指定可能です。加盟店様サイトに近づけた決済画面を提供することができます。オリジナルデザインについてはオリジナルデザイン利用マニュアルをご確認ください。オリジナルデザイン機能は、現在テスト環境でのみ利用可能です。 ※本番環境では、2024年5月28日から利用可能となります。

〇

(null)

LogoUrl

半角英数字記号256桁

ロゴ画像URL

決済画面に表示するロゴ画像のURLです。「https」で始まるURLを指定してください。
ロゴ画像の横幅が222 pxを超える場合、横幅が最大222 pxとなるように縦横比を保持して自動的にサイズ調整を行います。
省略時は、ロゴが表示されません。

〇

(null)

ShopName

全半角英数字記号128桁

ショップ名

決済画面に表示するショップ名です。
省略時は、ショップ名を表示しません。

〇

(null)

ColorPattern

カラーパターン

決済画面の色合いを指定できます。以下の7種類から選択可能です。
省略時は、blue_01を使用します。各カラーの特徴は以下の通りです。

設定値	特徴
blue_01	青を基調とした明るい色合いです。
bluegray_01	灰色を基調とした落ち着いた色合いです。
skyblue_01	青空をイメージさせる爽やかな色合いです。
pink_01	春の桜をイメージさせる色合いです。
yellow_01	黄色を基調とした淡い色合いです。
black_01	黒を基調としたビビッとした色合いです。
nature_01	自然を感じさせる牧歌的な色合いです。
greengray_01	灰色に緑を溶け込ませた穏やかな色合いです。

〇

blue_01

Lang

半角英数2桁

言語コード

決済画面に表示する言語(ISO639コード)です。以下の言語から選択可能です。

設定値	言語
ja	日本語
en	英語
zh	中国語（簡体字）

〇

ShopDomain

ショップドメイン

決済画面をiframeなどを使用して表示する際に表示するページのドメインを配列で指定します。
iframeで表示しない場合は指定しないでください。
最大5件設定可能で、1件あたり、ドメイン部分は253バイトまで許容しています。
半角英数63バイトまでの文字を、.(ドット)でつないで設定できます。
加盟店様での開発のために、http / https などのプロトコルと、IPアドレスV4、ポート番号を設定可能です。

例1）ドメイン名のみの指定
example.com
例2）ドメイン名とプロトコルの指定
http://example.com
例3）ドメイン名とプロトコル、ポート番号の指定
http://example.com:8080
例4）IPアドレスの指定
http://127.0.0.1:8080
IPアドレスの指定はIPV4に対応しています。
必ずプロトコルとポート番号を指定してください。

ShopDomain設定例）
単数設定する場合：["example.com"]
複数設定する場合：["example.com","http://127.0.0.1:8080"]

iframeなどでページを埋め込む場合、一部の決済手段を利用する際に、加盟店様ページで実装する必要があるJavascriptがあります。
詳しくは以下を参照ください。
iframeタグの利用について

〇

(null)

{決済識別子}

決済固有取引情報

各決済手段ごとに必要な取引情報のパラメータセットです。
詳細は各決済手段の章をご覧ください。

表の説明

・「指定可能箇所／リンクタイプ Plus決済URL」に○が付いている場合、リンクタイプ Plus決済URLで指定が可能です。
・「指定可能箇所／加盟店デフォルト設定」に○が付いている場合、管理画面で指定が可能です。
・「システムデフォルト値」は「リンクタイプ Plus決済URL」「加盟店デフォルト設定」で指定が無い場合に使われる値です。
※使用されるパラメータの優先順位は以下の通りです。
①リンクタイプ Plus決済URL →②加盟店デフォルト設定→③システムデフォルト値

customer情報が使用される決済手段一覧表

決済手段＼項目名	メールアドレス	氏名	氏名(カナ)	電話番号
コンビニ	〇	〇	〇	〇
Pay-easy（ペイジー）	〇	〇	〇	〇
銀行振込（バーチャル口座）	〇	〇	-	-
銀行振込（バーチャル口座あおぞら）	〇	〇	-	-

customer情報を設定した場合、以下の図のように入力画面のデフォルト値として表示されます。

図　customer情報が設定された場合の決済デフォルト画面例（決済手段：コンビニ）

決済共通部に設定した項目は以下の通り、画面に表示されます。

図　決済共通部項目設定値と画面表示対応／テンプレートサンプル：designA

図　テンプレートサンプル：designB

図　テンプレートサンプル：designC

図　テンプレートサンプル：designD

図　テンプレートサンプル：オリジナルデザイン（デフォルト設定値）

決済画面からの加盟店様サイトへの遷移

実行パラメータセットの戻り先URL、完了時戻り先URL、キャンセル時戻り先URLの内いずれかの戻り先URLを指定すると、リンクタイプ Plus決済画面上に「サイトに戻る」ボタンが表示され、該当ボタンを押下すると遷移先URLへ画面遷移します。
「サイトに戻る」ボタン押下時の動作は以下の通りです。

遷移先URL	下表参照
メソッド	POST
パラメータ	"result"にハッシュ付き結果パラメータセットを設定ハッシュ仕様はハッシュ付き実行パラメータセットと同じです。結果パラメータセットの仕様は次頁をご覧ください。

実行パラメータの設定			サイトに戻るボタン
戻り先URL （RetUrl）	完了時戻り先URL （CompleteUrl）	キャンセル時戻り先URL （CancelUrl）	レシート画面	レシート画面以外
あり	なし	なし	「戻り先URL」に遷移する	「戻り先URL」に遷移する
なし	なし	なし	非表示	非表示
あり	あり	あり	「完了時戻り先URL」に遷移する	「キャンセル時戻り先URL」に遷移する
あり	あり	なし	「完了時戻り先URL」に遷移する	非表示
あり	なし	あり	非表示	「キャンセル時戻り先URL」に遷移する
なし	あり	あり	「完了時戻り先URL」に遷移する	「キャンセル時戻り先URL」に遷移する
なし	あり	なし	「完了時戻り先URL」に遷移する	非表示
なし	なし	あり	非表示	「キャンセル時戻り先URL」に遷移する

注意点

遷移先URLへの画面遷移は決済完了時以外にも、決済手続きの途中で「サイトに戻る」ボタンが押下された場合などに決済未完了状態で戻る場合があります。
お客様が「サイトに戻る」ボタンを押下せずにブラウザを閉じた場合など、遷移先URLへ画面遷移が行われない場合があります。

結果パラメータセット項目説明

結果パラメータは、共通部と決済固有部に大別されます。

本章では共通部について説明します（決済固有部については各決済手段の章をご覧ください）。

結果パラメータ項目(決済共通部)

transactionresult

取引共通項目

取引に共通な結果パラメータセットです。

AccessID

半角英数32桁固定

取引ID

決済が実行された場合は、設定されます。

AccessPass

半角英数32桁固定

取引パスワード

決済が実行された場合は、設定されます。

OrderID

半角数字記号27桁

オーダーID

Result

リンクタイプ Plus処理結果

リンクタイプ Plus決済の処理結果(状態)が設定されます。

処理結果（状態）	説明
CREATE	決済URL取得APIを実行して、URLを発行した状態
SEND	お客様に決済URL案内メールを送信した状態
PAYSTART	リンクタイプ Plus決済URLにお客様がアクセスし決済選択/入力画面を表示した状態
CONFIRM	お客様が決済選択/入力画面上で確定ボタンを押下し、決済確認画面を表示した状態
REQPROCESS	お客様が決済確認画面上で確定ボタンを押下し、決済処理が開始された状態
REQSUCCESS	お客様が決済手続きを完了し、お客様の入金処理が必要な状態
PAYSUCCESS	決済手続きが完了した状態
ERROR	決済手続きが失敗した状態（お客様の操作による決済手続きの中止を含みます）
EXPIRED	加盟店様が指定した取引有効日数内に決済手続きが完了しなかった状態
INVALID	加盟店様の操作によりリンクタイプ Plus取引が無効化された状態（加盟店様による取引中止）

Processdate

処理日時

処理が行われた日時が設定されます。（yyyy/mm/dd hh:MM:ss形式）

ErrCode

半角英数3桁

エラーコード

ErrInfo

半角英数9桁

エラー詳細コード

Paymethod

選択決済手段

決済が実行された場合は、利用された決済手段の識別子が設定されます。

{決済識別子}

決済固有取引情報

決済が実行された場合は、実行された決済手段の処理結果が設定されます。
詳細は各決済手段の章をご覧ください。